dbusServices: Refactor service utilities from fileUtils into dbusUtils

To enable porting services to ECMAScript modules independently of
the shell, split DBus service utility functions into a new file,
dbusUtils.js

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/2365>

diff --git a/js/dbusServices/extensions/extensionsService.js b/js/dbusServices/extensions/extensionsService.js
index 6144dbab4a16876b8b4a5f6306d4bf7524d2ffa4..f863489a72fd43b4a503f4e735e97dac41af303f 100644 (file)
--- a/js/dbusServices/extensions/extensionsService.js
+++ b/js/dbusServices/extensions/extensionsService.js
@@ -5,7 +5,7 @@ const { Gio, GLib, Shew } = imports.gi;
 
 const ExtensionUtils = imports.misc.extensionUtils;
 
-const { loadInterfaceXML } = imports.misc.fileUtils;
+const { loadInterfaceXML } = imports.misc.dbusUtils;
 const { ExtensionPrefsDialog } = imports.extensionPrefsDialog;
 const { ServiceImplementation } = imports.dbusService;
 

diff --git a/js/dbusServices/notifications/notificationDaemon.js b/js/dbusServices/notifications/notificationDaemon.js
index d0c97860cb04818e22bd7b56658dc3fc3b312a91..10f0ddacf0510096e4d96b895c409af10d8d3fc5 100644 (file)
--- a/js/dbusServices/notifications/notificationDaemon.js
+++ b/js/dbusServices/notifications/notificationDaemon.js
@@ -3,7 +3,7 @@
 
 const { Gio, GLib } = imports.gi;
 
-const { loadInterfaceXML } = imports.misc.fileUtils;
+const { loadInterfaceXML } = imports.misc.dbusUtils;
 const { ServiceImplementation } = imports.dbusService;
 
 const NotificationsIface = loadInterfaceXML('org.freedesktop.Notifications');

diff --git a/js/dbusServices/org.gnome.ScreenSaver.src.gresource.xml b/js/dbusServices/org.gnome.ScreenSaver.src.gresource.xml
index 834167b9552584c11f30a431098595b526040234..d77f72a6895e4b37d1e857f883548436c356f779 100644 (file)
--- a/js/dbusServices/org.gnome.ScreenSaver.src.gresource.xml
+++ b/js/dbusServices/org.gnome.ScreenSaver.src.gresource.xml
@@ -6,6 +6,6 @@
     <file>dbusService.js</file>
 
     <file>misc/config.js</file>
-    <file>misc/fileUtils.js</file>
+    <file>misc/dbusUtils.js</file>
   </gresource>
 </gresources>

diff --git a/js/dbusServices/org.gnome.Shell.Extensions.src.gresource.xml b/js/dbusServices/org.gnome.Shell.Extensions.src.gresource.xml
index c3b81cfc21e6ce090f12d974e8fc4ae5885f99fe..3ab92a20e9c87a02f8b7742df3c003d0557822ff 100644 (file)
--- a/js/dbusServices/org.gnome.Shell.Extensions.src.gresource.xml
+++ b/js/dbusServices/org.gnome.Shell.Extensions.src.gresource.xml
@@ -8,7 +8,7 @@
 
     <file>misc/config.js</file>
     <file>misc/extensionUtils.js</file>
-    <file>misc/fileUtils.js</file>
+    <file>misc/dbusUtils.js</file>
     <file>misc/params.js</file>
   </gresource>
 

diff --git a/js/dbusServices/org.gnome.Shell.Notifications.src.gresource.xml b/js/dbusServices/org.gnome.Shell.Notifications.src.gresource.xml
index ccf0e98a72b23596fec8e455a1e54213b4b4f27f..4e039ba69bd3ebd1192182dd3ad0ea9a16fb50b9 100644 (file)
--- a/js/dbusServices/org.gnome.Shell.Notifications.src.gresource.xml
+++ b/js/dbusServices/org.gnome.Shell.Notifications.src.gresource.xml
@@ -6,6 +6,6 @@
     <file>dbusService.js</file>
 
     <file>misc/config.js</file>
-    <file>misc/fileUtils.js</file>
+    <file>misc/dbusUtils.js</file>
   </gresource>
 </gresources>

diff --git a/js/dbusServices/org.gnome.Shell.Screencast.src.gresource.xml b/js/dbusServices/org.gnome.Shell.Screencast.src.gresource.xml
index e99b1ac18149271dffdc4135d64d7e9ba7777ea6..292f0f1608c71a5864951024a52323f4b35dc805 100644 (file)
--- a/js/dbusServices/org.gnome.Shell.Screencast.src.gresource.xml
+++ b/js/dbusServices/org.gnome.Shell.Screencast.src.gresource.xml
@@ -6,6 +6,6 @@
     <file>dbusService.js</file>
 
     <file>misc/config.js</file>
-    <file>misc/fileUtils.js</file>
+    <file>misc/dbusUtils.js</file>
   </gresource>
 </gresources>

diff --git a/js/dbusServices/screencast/screencastService.js b/js/dbusServices/screencast/screencastService.js
index 1fdf5c766e84144222b5dc57f9f6c4bbb1444a37..73f6b5595e071938da752dd9f4424f7e08fc79f8 100644 (file)
--- a/js/dbusServices/screencast/screencastService.js
+++ b/js/dbusServices/screencast/screencastService.js
@@ -6,7 +6,7 @@ imports.gi.versions.Gtk = '4.0';
 
 const { Gio, GLib, Gst, Gtk } = imports.gi;
 
-const { loadInterfaceXML, loadSubInterfaceXML } = imports.misc.fileUtils;
+const { loadInterfaceXML, loadSubInterfaceXML } = imports.misc.dbusUtils;
 const { ServiceImplementation } = imports.dbusService;
 
 const ScreencastIface = loadInterfaceXML('org.gnome.Shell.Screencast');

diff --git a/js/dbusServices/screensaver/screenSaverService.js b/js/dbusServices/screensaver/screenSaverService.js
index bd3687ef60071915d735355063bf76438168690a..dbf2a82fb9c79055041dca315b8277fa78d998b5 100644 (file)
--- a/js/dbusServices/screensaver/screenSaverService.js
+++ b/js/dbusServices/screensaver/screenSaverService.js
@@ -3,7 +3,7 @@
 
 const { Gio, GLib } = imports.gi;
 
-const { loadInterfaceXML } = imports.misc.fileUtils;
+const { loadInterfaceXML } = imports.misc.dbusUtils;
 const { ServiceImplementation } = imports.dbusService;
 
 const ScreenSaverIface = loadInterfaceXML('org.gnome.ScreenSaver');

diff --git a/js/js-resources.gresource.xml b/js/js-resources.gresource.xml
index fc5af0aee03afd5baf387096f8aa1bcdbca6bf8b..642ad05c3d2e9bd373b9ff0c055f28a180210b0b 100644 (file)
--- a/js/js-resources.gresource.xml
+++ b/js/js-resources.gresource.xml
@@ -14,6 +14,7 @@
     <file>misc/config.js</file>
     <file>misc/extensionUtils.js</file>
     <file>misc/fileUtils.js</file>
+    <file>misc/dbusUtils.js</file>
     <file>misc/gnomeSession.js</file>
     <file>misc/history.js</file>
     <file>misc/ibusManager.js</file>

diff --git a/js/misc/dbusUtils.js b/js/misc/dbusUtils.js
new file mode 100644 (file)
index 0000000..ac26894
--- /dev/null
+++ b/js/misc/dbusUtils.js
@@ -0,0 +1,68 @@
+// -*- mode: js; js-indent-level: 4; indent-tabs-mode: nil -*-
+/* exported loadInterfaceXML, loadSubInterfaceXML */
+
+const Config = imports.misc.config;
+const { Gio, GLib } = imports.gi;
+
+let _ifaceResource = null;
+
+/**
+ * @private
+ */
+function _ensureIfaceResource() {
+    if (_ifaceResource)
+        return;
+
+    // don't use global.datadir so the method is usable from tests/tools
+    let dir = GLib.getenv('GNOME_SHELL_DATADIR') || Config.PKGDATADIR;
+    let path = `${dir}/gnome-shell-dbus-interfaces.gresource`;
+    _ifaceResource = Gio.Resource.load(path);
+    _ifaceResource._register();
+}
+
+/**
+ * @param {string} iface the interface name
+ * @returns {string | null} the XML string or null if it is not found
+ */
+function loadInterfaceXML(iface) {
+    _ensureIfaceResource();
+
+    let uri = `resource:///org/gnome/shell/dbus-interfaces/${iface}.xml`;
+    let f = Gio.File.new_for_uri(uri);
+
+    try {
+        let [ok_, bytes] = f.load_contents(null);
+        return new TextDecoder().decode(bytes);
+    } catch (e) {
+        log(`Failed to load D-Bus interface ${iface}`);
+    }
+
+    return null;
+}
+
+/**
+ * @param {string} iface the interface name
+ * @param {string} ifaceFile the interface filename
+ * @returns {string | null} the XML string or null if it is not found
+ */
+function loadSubInterfaceXML(iface, ifaceFile) {
+    let xml = loadInterfaceXML(ifaceFile);
+    if (!xml)
+        return null;
+
+    let ifaceStartTag = `<interface name="${iface}">`;
+    let ifaceStopTag = '</interface>';
+    let ifaceStartIndex = xml.indexOf(ifaceStartTag);
+    let ifaceEndIndex = xml.indexOf(ifaceStopTag, ifaceStartIndex + 1) + ifaceStopTag.length;
+
+    let xmlHeader = '<!DOCTYPE node PUBLIC\n' +
+        '\'-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\'\n' +
+        '\'http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\'>\n' +
+        '<node>\n';
+    let xmlFooter = '</node>';
+
+    return (
+        xmlHeader +
+        xml.substr(ifaceStartIndex, ifaceEndIndex - ifaceStartIndex) +
+        xmlFooter);
+}

diff --git a/js/misc/fileUtils.js b/js/misc/fileUtils.js
index 88f043a79a3ae43dc88bea47ff6ec28d6d868da7..4c86948a91c2b4bf76e6579d6a2e21428a0bcb70 100644 (file)
--- a/js/misc/fileUtils.js
+++ b/js/misc/fileUtils.js
@@ -3,7 +3,8 @@
             recursivelyMoveDir, loadInterfaceXML, loadSubInterfaceXML */
 
 const { Gio, GLib } = imports.gi;
-const Config = imports.misc.config;
+
+var { loadInterfaceXML } = imports.misc.dbusUtils;
 
 function collectFromDatadirs(subdir, includeUserDir, processFile) {
     let dataDirs = GLib.get_system_data_dirs();
@@ -65,53 +66,3 @@ function recursivelyMoveDir(srcDir, destDir) {
             recursivelyMoveDir(srcChild, destChild);
     }
 }
-
-let _ifaceResource = null;
-function ensureIfaceResource() {
-    if (_ifaceResource)
-        return;
-
-    // don't use global.datadir so the method is usable from tests/tools
-    let dir = GLib.getenv('GNOME_SHELL_DATADIR') || Config.PKGDATADIR;
-    let path = `${dir}/gnome-shell-dbus-interfaces.gresource`;
-    _ifaceResource = Gio.Resource.load(path);
-    _ifaceResource._register();
-}
-
-function loadInterfaceXML(iface) {
-    ensureIfaceResource();
-
-    let uri = `resource:///org/gnome/shell/dbus-interfaces/${iface}.xml`;
-    let f = Gio.File.new_for_uri(uri);
-
-    try {
-        let [ok_, bytes] = f.load_contents(null);
-        return new TextDecoder().decode(bytes);
-    } catch (e) {
-        log(`Failed to load D-Bus interface ${iface}`);
-    }
-
-    return null;
-}
-
-function loadSubInterfaceXML(iface, ifaceFile) {
-    let xml = loadInterfaceXML(ifaceFile);
-    if (!xml)
-        return null;
-
-    let ifaceStartTag = `<interface name="${iface}">`;
-    let ifaceStopTag = '</interface>';
-    let ifaceStartIndex = xml.indexOf(ifaceStartTag);
-    let ifaceEndIndex = xml.indexOf(ifaceStopTag, ifaceStartIndex + 1) + ifaceStopTag.length;
-
-    let xmlHeader = '<!DOCTYPE node PUBLIC\n' +
-        '\'-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\'\n' +
-        '\'http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\'>\n' +
-        '<node>\n';
-    let xmlFooter = '</node>';
-
-    return (
-        xmlHeader +
-        xml.substr(ifaceStartIndex, ifaceEndIndex - ifaceStartIndex) +
-        xmlFooter);
-}

diff --git a/js/portal-resources.gresource.xml b/js/portal-resources.gresource.xml
index 3fd878365ada74003b599a540aae67e5dfe05159..dbcf11b1d04a012f4fcdbc3d71a0f36bf593a382 100644 (file)
--- a/js/portal-resources.gresource.xml
+++ b/js/portal-resources.gresource.xml
@@ -4,6 +4,6 @@
     <file>portalHelper/main.js</file>
 
     <file>misc/config.js</file>
-    <file>misc/fileUtils.js</file>
+    <file>misc/dbusUtils.js</file>
   </gresource>
 </gresources>